home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pcbt0990.zip / PCBTIC.DOC < prev    next >
Text File  |  1993-04-18  |  17KB  |  432 lines
  1.   PCBTIC ver 1.00             (c) Copyright XON/XOFF Computer Solutions, 1992
  2.                                                  XON/XOFF Information Service
  3.                                                         Robert & Joel Lechter
  4.  
  5.   ╒═════════════════════════════════════════════════════════════════════════╕
  6.   │                                                                         │
  7.   │                                                                         │
  8.   │                         B E T A   V E R S I O N                         │
  9.   │                                                                         │
  10.   │                                                                         │
  11.   ╘═════════════════════════════════════════════════════════════════════════╛
  12.  
  13. ■ Minimum Requirements:
  14.  
  15.       · A 286 or better computer.  8086/8088 version is available upon
  16.         request.
  17.  
  18.       · 220 KB conventional RAM.
  19.  
  20.       · FrontDoor 2.02 & 2.10, BinkleyTerm, or D'Bridge 1.51.  Other mailers
  21.         will be supported as time allows.  Contact the author for specific
  22.         requests.
  23.  
  24.         Due to the automatic mailer detection of PCBTIC, future mailer
  25.         versions may not function properly with PCBTIC.  In that case,
  26.         contact the author of PCBTIC for an upgrade.
  27.  
  28.  
  29. ■ What is PCBTIC?
  30.  
  31.         PCBTIC is the ultimate .TIC file processor for PCBoard.
  32.  
  33.         PCBTIC is a program which will process incoming TIC files, and import
  34.         them into the PCBoard DIR Text File format (PCBoard file
  35.         descriptions).
  36.  
  37.         Originally it was intended for our personal use in importing TIC
  38.         files to our PCBoard BBS.  As our needs grew, so did the program.
  39.         When we were assigned FidoNet Hub status, we had to begin exporting
  40.         files, so the program was recoded.  Then we had to start supporting
  41.         points, so more recoding.  Little by little, the program has evolved
  42.         into the little monster that it is, with almost 6000 lines of code.
  43.  
  44.  
  45. ■ What is a TIC file?
  46.  
  47.         A TIC file (named TKxxxxxx.TIC) is a file which accompanies
  48.         officially distributed File Distribution Network files.  You probably
  49.         get a couple TIC's each week with your NODEDIFF and the Fido news
  50.         (FNEWSxxxx), but never really knew what to do with them.  We USED to
  51.         delete them, but no more!
  52.  
  53.         TIC files contain a bunch of information about the attached file,
  54.         including its path from the author to you, the description, and a
  55.         CRC.
  56.  
  57.  
  58. ■ Who needs it?
  59.  
  60.         With the growing number of PCBoard BBS's which are becoming Fido
  61.         compatible (especially using FidoPCB), this is an essential program
  62.         to properly import incoming TIC files to the PCBoard DIR Text file
  63.         format.  The original program, TICK, does not properly import the
  64.         descriptions into the PCBoard format--in spite of the documentation--
  65.         and, in fact, severely corrupts the descriptions, such that PCBFILER
  66.         can't access them.
  67.  
  68.         I tried a number of other PCBoard TIC processors, and found their
  69.         abilities lacking; in previous versions of OTHER processors, files
  70.         were only able to be imported to one directory, or no real CRC
  71.         checking was done, or no redistribution of files was allowed.
  72.  
  73.  
  74. ■ Legal Stuff
  75.  
  76.         We are currently running this program on our own multi-line PCBoard
  77.         (14.5a/10) BBS under LANtastic and it hasn't trashed anything, so I
  78.         guess it works.  In fact, we are a FidoNet hub (look for us in the
  79.         NODELIST!), so we regularly redistribute files.
  80.         
  81.         NOTE: PCBTIC does not yet support file/record locking.  This will be
  82.               available in a future release.
  83.  
  84.  
  85. ■ How can you contact the author?
  86.  
  87.         The easiest way you can send us a message, since you are a Fido
  88.         compatible system, is via NetMail to 1:167/159.
  89.  
  90.         We can also be reached on our own 24 hour BBS at (514) 683-6729
  91.         (USRobotics Dual Standard 16800) or by fax at (514) 685-1152 (7am -
  92.         9pm Eastern Time).
  93.  
  94.         Network addresses:
  95.                 FidoNet:                          1:167/159
  96.                 KESHERnet:                       18:716/201
  97.                 FrancoMedia:                    101:190/105
  98.                 NAnet:                             51/41/12
  99.                 EchoNet:                           51/40/52
  100.                 Internet:        Robert.Lechter@xonxoff.com
  101.         
  102.  
  103. ■ Why would you want to contact the author?
  104.  
  105.       · First and foremost to report a bug.
  106.       · To send us your comments about the program.
  107.       · You might want to offer suggestions for added features in future
  108.         releases.
  109.       · To get information on custom versions.
  110.  
  111.         I look forward to your input.
  112.  
  113.  
  114. ■ How do I set-up PCBTIC?
  115.  
  116.         The configuration file is quite straightforward.  There are two types
  117.         of area declarations.
  118.  
  119.         Example #1:
  120.  
  121.                 AREA NODEDIFF             <──── The area defined by the sender
  122.                  c:\files\dirfl1          <──── where the descriptions go.
  123.                  g:\pcb\fd\nodelist       <──── where the file actually goes.
  124.                  NODEDIFF                 <──── The password for this area
  125.                  FROM 1:167/159 HISPASS   <──── Straightforward, with password.
  126.                  TO 1:1/1 PASS1           <──── Straightforward, with password.
  127.                  TO 2:3/4.5 PASS2 NOTIC   <──── As above, but no TIC file will
  128.                                                 be made for this address.
  129.                  TO 2:3/4 PASS NOTIC CRASH
  130.                  TO 5:6/7 PASS HOLD
  131.                  TO 1:2/2 PASS NOTIC HOLD
  132.  
  133.  
  134.         The above example indicates that the files will be imported into
  135.         PCBoard, as well as possibly being echoed, if there is a valid TO
  136.         directive.
  137.  
  138.         Example #2:
  139.  
  140.                 AREA SOME_AREA
  141.                  passthru
  142.                  FROM ...
  143.                  TO   ...
  144.  
  145.         The above example indicates that the files in this area will NOT be
  146.         imported into PCBoard, but merely echoed to the destination sites.
  147.  
  148.         Please note that if no TO addresses are listed, any incoming files in
  149.         a PASSTHRU area will be deleted.
  150.  
  151.  
  152.         There are a few other switches in the CFG file that are user
  153.         adjustable.
  154.  
  155.         REPLACE         Optionally deletes old version of new files.
  156.  
  157.         DUPECHECK       Enables checking for duplicates based on CRC's.
  158.  
  159.         CHANGEDATE      Optionally changes the date of the incoming files, or
  160.                         leave them as is.  It is recommended that this switch
  161.                         be left ON, since a (N)ew file scan will then work
  162.                         properly.
  163.  
  164.         CONFIG          The directory for your mailer.  PCBTIC will read that
  165.                         configuration file for more information.  This is to
  166.                         make your life simpler by reducing the size and
  167.                         complexity of this configuration file.
  168.  
  169.         TIME            Indicates how the program should handle the switch
  170.                         from standard to daylight time.  I have found the way
  171.                         that other programs implement this (the TZ
  172.                         environment variable) lacking, since it can't account
  173.                         for variances between countries.
  174.  
  175.                         Format:  TIME s, d, interval
  176.  
  177.                         where `s' indicates the number of hours to add to
  178.                               current system time to get UTC (GMT) during
  179.                               standard time (+5 for east coast of North
  180.                               America)
  181.  
  182.                               `d' indicates the number of hours to add during
  183.                               daylight savings time (+4 for east coast of
  184.                               N.A.)
  185.  
  186.                               `interval' indicates the time interval that
  187.                               savings time is in effect.  It can be an
  188.                               absolute date, such as `1 APR - 15 OCT' or a
  189.                               relative date, such as `2 SUN APR - 5 TUE OCT'.
  190.                               This relative date indicates the second Sunday
  191.                               in April until the 5th (or last) Tuesday in
  192.                               October.
  193.  
  194.                         If your system time is UTC, then you can simply use
  195.                         TIME UTC (or TIME GMT).
  196.  
  197.  
  198. ■ Command line options:
  199.  
  200.         /debug:n        Logs more information for debugging purposes.  Be
  201.                         careful!  The larger the number, the more info gets
  202.                         placed into your log file.
  203.  
  204.                         WARNING: Level 9 makes HUGE log files, and has been
  205.                                  included for special debugging.
  206.  
  207.         /nocrc          Forces files with bad CRC's or TIC's with no CRC's to
  208.                         be imported.
  209.  
  210.         /hatch          Sets PCBTIC into HATCH mode whereby it will originate
  211.                         a file and send it out.
  212.  
  213.  
  214. ■ Is PCBTIC network aware?
  215.  
  216.         Not yet.  We are using it on a network, but haven't yet made it with
  217.         file locking and sharing capability.  One catastrophe at a time,
  218.         please.
  219.  
  220.  
  221. ■ How do I hatch (originate) a file?
  222.  
  223.         There are two ways to do this.
  224.  
  225.         The first way, by simply typing "/hatch" on the command line, will run
  226.         PCBTIC's hatch option in interactive mode.
  227.  
  228.                         ex: PCBTIC /hatch
  229.  
  230.         The second way is to use "/hatch=filespec" on the command line.  Note,
  231.         that there are no spaces in this parameter.  The filespec represents an
  232.         ASCII file which has the format which follows.  This will allow you to
  233.         have automated hatchings, if you so desire.
  234.  
  235.             line 1:     Area name in which to hatch the file.
  236.             line 2:     Full path and filename of the target file.
  237.             line 3:     Description of the file.
  238.             line 4:     OPTIONAL: The name of the file this file replaces.
  239.  
  240.                         ex: PCBTIC /hatch=f:\mydir\distrib1.dis
  241.  
  242.  
  243. ■ Why should I register PCBTIC?
  244.  
  245.         If you find this program useful and time-saving, you should register
  246.         the program.  This will ensure that we can properly support it.
  247.  
  248.         Registration will also allow more than three areas to function.
  249.  
  250.         Additionally, some companion programs will be released which will
  251.         work alongside PCBTIC.  These programs will only work with the
  252.         registered version of PCBTIC.
  253.  
  254.  
  255. ■ How do I register PCBTIC?
  256.  
  257.         Please see the PCBTIC.REG file (registartion form) and PCBTIC.VER
  258.         (version information) enclosed in this archive.
  259.  
  260.  
  261. ■ How much does registration cost?
  262.  
  263.         A new fee structure has been announced.
  264.  
  265.         The registration fee is 15$.  This will enable all the features of
  266.         the program for 25 file areas (60 cents per area).
  267.  
  268.         For more areas, please see the PCBTIC.VER file.
  269.  
  270.  
  271. ■ Three areas is not enough to properly evaluate PCBTIC.
  272.  
  273.         We have now coded the program (starting at version 0.986) to accept a
  274.         DEMO key.  This file can be obtained by sending NetMail to 1:167/159
  275.         with your mailer's address, and the number of conferences you wish to
  276.         evaluate.
  277.  
  278.         A demo key file will be prepared, and you will be notified by return
  279.         NetMail that it is on hold for you.
  280.  
  281.  
  282. ■ Why is there no upper limit on the registration fee?
  283.  
  284.         We have been asked this question quite a few times, and have pondered
  285.         whether or not to place a ceiling on the fees.  Our conclusion was
  286.         not to limit the fee.  After consulting with a number of SysOps, we
  287.         determined that 25 areas was reasonable.  Once this number of file
  288.         areas is reached, that system is probably a commercial system.
  289.  
  290.         Since PCBoard BBS's are often larger (i.e. more users, and more phone
  291.         lines) than other BBS programs, it is was not deemed fair to charge
  292.         an amateur system and a commercial system the same amount for the
  293.         program.
  294.  
  295.         If you are an amateur system which does not charge its users, and
  296.         would really like to use PCBTIC, but the number of areas you carry
  297.         would price it out of your range, I suggest asking you users (or
  298.         those that download files) for a small (i.e. 2$) donation to pay for
  299.         this program and help offset your phone, and electric bills.
  300.         
  301.  
  302. ■ What does the REGISTERED version do that the unregistered doesn't?
  303.  
  304.   Areas supported:
  305.           unr:   a maximum of three areas.
  306.           reg:   unlimited (actually limited by KEY file)
  307.  
  308.    Nuisances:
  309.           unr:  Delay upon program completion.
  310.           reg:  No delay.
  311.  
  312.  
  313. ■ What will future 1.xx releases do?
  314.  
  315.       · Well, network awareness is on the agenda, as well as support for
  316.         other front-end mailers.
  317.       · The .BAT file implementation is also scheduled for an overhaul.
  318.       · Detect of self-extracting archives.
  319.       · More mailer types will be supported.
  320.  
  321.  
  322.  
  323. ■ What about future versions of PCBTIC?
  324.  
  325.         No details are available yet, but some companion programs are in the
  326.         works.
  327.  
  328.  
  329. ■ Hints for proper integration of PCBTIC, your mailer, and your BBS.
  330.  
  331.         Our mailer (FrontDoor) is set to exit after any file is received.
  332.         Here is the .BAT file segment that we use in order to integrate
  333.         PCBTIC into our BBS.
  334.  
  335.                                        .
  336.                                        .
  337.                                        .
  338.         if not exist g:\frontdor\inbound\*.TIC goto NoTICK
  339.         usernet c:\pcb\main\usernet.xxx 1 Y * * "Processing new files"
  340.         f:
  341.         cd \pcbtic
  342.  
  343.         rem     * While the next two lines are not needed, we include them,
  344.         rem       just in case the PCBTIC.EXE program is not found.  It will
  345.         rem       eliminate AFTER.BAT being run each time, and it will
  346.         rem       eliminate the report file being inserted each time.
  347.  
  348.         if exist after.bat del after.bat
  349.         if exist pcbtic.rpt del pcbtic.rpt
  350.  
  351.         pcbtic
  352.  
  353.         rem Update headers and check for viruses.
  354.         if exist after.bat call after
  355.  
  356.         rem     * Import new files report (This is all one command line.)
  357.         rem     * Robert Vostrey's TXT2MSG program is required.
  358.  
  359.         if exist pcbtic.rpt c:\txt2msg\txt2msg C:\PCB\MAIN\MSG -p -tALL
  360.                 -fPCBTIC -sNEW_FILES_IN_CONF_2 pcbtic.rpt
  361.  
  362.         rem Update PCBoard's download index files, if applicable.
  363.  
  364.         call c:\pcb\refresh.bat
  365.                  .
  366.                  .
  367.                  .
  368.  
  369.  
  370.  
  371. ■ ERRORLEVELS
  372.  
  373.         When PCBTIC exits, it will set the ERRORLEVEL which can be checked
  374.         by your .BAT file.
  375.  
  376.           1 - Unable to open CFG file.
  377.           2 - Error message handler variable is out of bounds.
  378.           5 - Can't find inbound directory (as reported by mailer).
  379.           6 - Inbound directory is not a directory.
  380.           7 - Can't find outbound directory (as reported by mailer).
  381.           8 - Outbound directory is not a directory.
  382.           9 - Can't find MAIL directory (where MSG files go).
  383.          10 - MAIL directory is not a directory.
  384.          11 - Corrupt KEY file.
  385.          12 - Corrupt KEY file.
  386.          13 - Corrupt KEY file.
  387.          14 - Corrupt KEY file.
  388.          15 - KEY file is outdated.
  389.          16 - Unknown mailer type.
  390.          17 - Can't find mailer's directory.
  391.          18 - mailer's directory is not a directory.
  392.          20 - Can't find mailer's directory.
  393.          21 - Error in SETUP.FD file (FrontDoor only).
  394.          22 - No CONFIG entry in PCBTIC.CFG.
  395.          30 - Can't create work directory.
  396.          31 - Can't create work directory.
  397.          32 - Error in TIME directive
  398.          33 - No INBOUND directories in configuration file.
  399.          34 - Error in your address (in mailer configuration)
  400.  
  401.  
  402. ■ Echoing files
  403.  
  404.         PCBTIC can redistribute files to other sites.  This allows PCBoard
  405.         BBS's to  act as Fido hubs (as we are), or even as File Distibution
  406.         Network Systems.
  407.  
  408.  
  409. ■ Revision History
  410.  
  411.         Please see the PCBTIC.HST file.
  412.  
  413.  
  414. ■ Final Notes
  415.  
  416.         You are encouraged to send this file to other SysOps operating
  417.         PCBoard and front-end mailers.  If you do, please include the entire
  418.         archive in its original format, and do not change the distribution
  419.         name from the original name.
  420.  
  421.         We are interested in as much feedback as possible, so please drop us
  422.         a line.
  423.  
  424.         We freqent the FidoNet PCBNET conference, the FidoPCB support
  425.         conference, and the PCBoard Support conference.  Of course, NetMail
  426.         is always welcome!
  427.  
  428.                                         Robert & Joel Lechter
  429.                                         FidoNet 1:167/159
  430.  
  431.  
  432.